Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Fix typo in query-acceleration-blooms #14249

Merged
merged 1 commit into from
Sep 24, 2024
Merged

Conversation

titaneric
Copy link
Contributor

@titaneric titaneric commented Sep 24, 2024

What this PR does / why we need it:

Which issue(s) this PR fixes:
Fixes #

Special notes for your reviewer:

Checklist

  • Reviewed the CONTRIBUTING.md guide (required)
  • Documentation added
  • Tests updated
  • Title matches the required conventional commits format, see here
    • Note that Promtail is considered to be feature complete, and future development for logs collection will be in Grafana Alloy. As such, feat PRs are unlikely to be accepted unless a case can be made for the feature actually being a bug fix to existing behavior.
  • Changes that require user attention or interaction to upgrade are documented in docs/sources/setup/upgrade/_index.md
  • For Helm chart changes bump the Helm chart version in production/helm/loki/Chart.yaml and update production/helm/loki/CHANGELOG.md and production/helm/loki/README.md. Example PR
  • If the change is deprecating or removing a configuration option, update the deprecated-config.yaml and deleted-config.yaml files respectively in the tools/deprecated-config-checker directory. Example PR

@titaneric titaneric requested a review from a team as a code owner September 24, 2024 17:47
@CLAassistant
Copy link

CLAassistant commented Sep 24, 2024

CLA assistant check
All committers have signed the CLA.

@github-actions github-actions bot added the type/docs Issues related to technical documentation; the Docs Squad uses this label across many repositories label Sep 24, 2024
Copy link
Contributor

@JStickler JStickler left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[docs -team] LGTM, thanks for taking the time to update the documentation.

@loki-gh-app
Copy link
Contributor

loki-gh-app bot commented Sep 24, 2024

This PR must be merged before a backport PR will be created.

2 similar comments
@loki-gh-app
Copy link
Contributor

loki-gh-app bot commented Sep 24, 2024

This PR must be merged before a backport PR will be created.

@loki-gh-app
Copy link
Contributor

loki-gh-app bot commented Sep 24, 2024

This PR must be merged before a backport PR will be created.

@JStickler JStickler merged commit b79210c into grafana:main Sep 24, 2024
71 checks passed
@loki-gh-app
Copy link
Contributor

loki-gh-app bot commented Sep 24, 2024

The backport to release-3.0.x failed:

The process '/usr/bin/git' failed with exit code 1

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new branch
git switch --create backport-14249-to-release-3.0.x origin/release-3.0.x
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x b79210cd16c8379548ab61b36246948b0fab74a7

When the conflicts are resolved, stage and commit the changes:

git add . && git cherry-pick --continue

If you have the GitHub CLI installed:

# Push the branch to GitHub:
git push --set-upstream origin backport-14249-to-release-3.0.x
# Create the PR body template
PR_BODY=$(gh pr view 14249 --json body --template 'Backport b79210cd16c8379548ab61b36246948b0fab74a7 from #14249{{ "\n\n---\n\n" }}{{ index . "body" }}')
# Create the PR on GitHub
echo "${PR_BODY}" | gh pr create --title 'chore: [release-3.0.x] docs: Fix typo in query-acceleration-blooms' --body-file - --label 'size/XS' --label 'type/docs' --label 'backport' --base release-3.0.x --milestone release-3.0.x --web

Or, if you don't have the GitHub CLI installed (we recommend you install it!):

# Push the branch to GitHub:
git push --set-upstream origin backport-14249-to-release-3.0.x

# Create a pull request where the `base` branch is `release-3.0.x` and the `compare`/`head` branch is `backport-14249-to-release-3.0.x`.

# Remove the local backport branch
git switch main
git branch -D backport-14249-to-release-3.0.x

@loki-gh-app
Copy link
Contributor

loki-gh-app bot commented Sep 24, 2024

The backport to release-3.1.x failed:

The process '/usr/bin/git' failed with exit code 1

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new branch
git switch --create backport-14249-to-release-3.1.x origin/release-3.1.x
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x b79210cd16c8379548ab61b36246948b0fab74a7

When the conflicts are resolved, stage and commit the changes:

git add . && git cherry-pick --continue

If you have the GitHub CLI installed:

# Push the branch to GitHub:
git push --set-upstream origin backport-14249-to-release-3.1.x
# Create the PR body template
PR_BODY=$(gh pr view 14249 --json body --template 'Backport b79210cd16c8379548ab61b36246948b0fab74a7 from #14249{{ "\n\n---\n\n" }}{{ index . "body" }}')
# Create the PR on GitHub
echo "${PR_BODY}" | gh pr create --title 'chore: [release-3.1.x] docs: Fix typo in query-acceleration-blooms' --body-file - --label 'size/XS' --label 'type/docs' --label 'backport' --base release-3.1.x --milestone release-3.1.x --web

Or, if you don't have the GitHub CLI installed (we recommend you install it!):

# Push the branch to GitHub:
git push --set-upstream origin backport-14249-to-release-3.1.x

# Create a pull request where the `base` branch is `release-3.1.x` and the `compare`/`head` branch is `backport-14249-to-release-3.1.x`.

# Remove the local backport branch
git switch main
git branch -D backport-14249-to-release-3.1.x

loki-gh-app bot pushed a commit that referenced this pull request Sep 24, 2024
JStickler pushed a commit that referenced this pull request Sep 24, 2024
JStickler pushed a commit that referenced this pull request Sep 24, 2024
JStickler added a commit that referenced this pull request Sep 24, 2024
JStickler added a commit that referenced this pull request Sep 24, 2024
@@ -152,7 +152,7 @@ Example calculation for storage requirements of blooms for a single tenant.

Since reading blooms depends heavily on disk IOPS, Bloom Gateways should make use of multiple,
locally attached SSD disks (NVMe) to increase i/o throughput.
Multiple directories on different disk mounts can be specified using the `-bloom.shipper.working-directory` [setting][gateway-cfg]
Multiple directories on different disk mounts can be specified using the `-bloom.shipper.working-directory` [setting]storage-config-cfg]
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry, I miss the left bracket here, should I raise another PR?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, this one is already merged. Thanks for catching that!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport release-3.0.x backport release-3.1.x backport release-3.2.x backport-failed size/XS type/docs Issues related to technical documentation; the Docs Squad uses this label across many repositories
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants